home *** CD-ROM | disk | FTP | other *** search
/ Aminet 30 / Aminet 30 (1999)(Schatztruhe)[!][Apr 1999].iso / Aminet / comm / mail / GetMailWD.lha / GetMail.readme next >
Text File  |  1999-02-12  |  4KB  |  96 lines
  1. Short: FlashMail script for Miami&Yam - v1.4
  2. Author: Christopher 'WatchDog' Elliott
  3. Uploader: sembazuru@philadelphia.crosswinds.net
  4. Type: comm/mail
  5. Requires: ARexx, Miami, YAM2p6 or greater
  6.  
  7. This is a script to use with Miami and Yam to automate sending queued
  8. messages and retrieving new messages.
  9.  
  10. Features:
  11.  o If either Yam or Miami are not running, this script will start both
  12.     programs as needed.
  13.  o Yam and Miami program locations default to YAM:Yam and Miami:Miami,
  14.     respectively.  Uses environment variables to over ride these
  15.     defaults so you the end user don't need to modify the script.
  16.  o Logs Miami on at start and off at end.
  17.  o If Miami was online at start it remembers this so it won't log off.
  18.  o Commandline argument to force script to leave Miami online even if
  19.     Miami was offline at start.
  20.  o Commandline argument to tell it to tell Yam to filter messages
  21.     after it takes Miami offline. (Will also work even if you tell the
  22.     script to keep Miami online.) This allows you to have your YAM
  23.     filters not set on 'Filter New Mail' so you can save on your phone
  24.     (and ISP) bill.
  25.  o Commandline argument to tell it to get new mail before sending
  26.     outgoing messages.  I suggest that this feature is used with the
  27.     offline filter argument.
  28.  o Accepts YAM user and password info for passing to YAM. If YAM is
  29.     running, it checks to see if the current user name is the same as
  30.     what you specified. If not, it changes the Yam user.
  31.  
  32. NOTE: Due to a bug in YAM2p6, starting YAM with user information on
  33. the command line, the restart function is broken.  If you try to
  34. restart, it will restart with the originally supplied user info
  35. instead of prompting you for this info.  I have informed Marcel of
  36. this behaviour, and he agrees with me that this is incorrect
  37. behaviour.  Hopefully it should be fixed when he gets back on working
  38. on bug fixes.
  39.  
  40. Also, because of a lack of an ARexx feature to change the current Yam
  41. user in YAM2p6, the script has to close Yam and restart it with the
  42. new info.  Marcel has stated that he will eventually add this to the
  43. ARexx command set.
  44.  
  45. Installation:
  46. 1. Copy the script GetMail.rexx to REXX:, YAM:rexx/, or wherever you
  47.    keep your ARexx scripts.
  48.  
  49. 2. If you can't run Yam from the shell as 'YAM:Yam' then set the
  50.    environment variable 'GetMail.rexx/YAM_PATH' to your Yam path and
  51.    program name.  For example, if you call Yam 'YAM2p6' and keep it in
  52.    'AmTcp:Yam' then you would need to execute the following in your
  53.    shell:
  54. Shell> setenv GetMail.rexx/YAM_PATH AmTcp:Yam/YAM2p6
  55. Shell> copy env:GetMail.#? envarc: all
  56.  
  57. 3. Do the same for Miami if need be.  For example, I have
  58.    GetMail.rexx/MIAMI_PATH set to Miami:MiamiDx because I use Miami
  59.    Deluxe.
  60.  
  61. Uninstallation:
  62. 1. Delete the script from where ever you put it.
  63.  
  64. 2. Delete the directory ENVARC:GetMail.rexx
  65.  
  66. Usage: (Clipped from the output of the script)
  67. -------------------8<-------------------------
  68.  rx GetMail.rexx [USER "<user name>" [PASS "<user password>"]] [FILTEROFFLINE=FO] [STAYONLINE=SO] [GETBEFORESEND=GS]
  69.  
  70. To get this text, pass any invalid argument.
  71. USER and PASS will close Yam and restart it if the current user is different from
  72.  the user name passed as the argument.
  73. FILTEROFFLINE works best if few to none of your filters are configured to filter
  74.  new mail. NOTE: it will still filter if you use the STAYONLINE argument.
  75. STAYONLINE forces the script not to take Miami offline at the end of the script.
  76. GETBEFORESEND gets new mail before sending pending outgoing mail.  If you are
  77.  concerned about your time online, use this with FILTEROFFLINE, as if you have
  78.  YAM configured to filter new mail, the filtering will be done before outgoing
  79.  messages are sent.  This could also have the side effect of nullifying the
  80.  reason for using this switch as the filtering process may take longer than the
  81.  activity time-out of your mail server.
  82.  
  83. Use any version tool to get the current revision of this script.
  84. ------------------->8-------------------------
  85.  
  86. Distributrion:
  87. This script is email-ware.  Just send me a note (see uploader above)
  88. telling me that you use it.  Feel free to distribute it widely, but
  89. please don't charge more than media costs for it unless you kickback
  90. some of your profit to me. ;-)
  91. If you have any comments about the code, or new features wanted,
  92. please let me know.  I was happy with v1.1, but 1.2, 1.3, and 1.4 are
  93. the result of requests from other people.  Ask any ye [may] shall
  94. recieve. ;-)
  95.  
  96.